home *** CD-ROM | disk | FTP | other *** search
/ The Utilities Experience / The Utilities Experience - Volume 1.iso / software / workbench+shell / g-p / mcp / docs / aguideconv.doc < prev    next >
Text File  |  1995-07-22  |  3KB  |  118 lines
  1.  
  2. AGuideConv V1.0                             copyright 1994 by
  3. ===============                             Michael Friedrich
  4.                                            All Rights Reserved.
  5.  
  6.  
  7. Converts OS3.x-AmigaGuide-Texts to OS2.x-AmigaGuide-Texts
  8.  
  9.  
  10. Copyright
  11. =========
  12. This software is copyright 1994 by Michael Friedrich. All Rights Reserved.
  13. Is is PUBLIC DOMAIN, so you may use this piece of software freely.
  14. This software may be freely distributed as long as no more than a nominal
  15. fee is charged to cover time and copying costs.
  16. Commercial usage is only allowed with the written permission of the author.
  17.  
  18. Disclaimer: The author makes no warranties, either expressed or implied.
  19. This program is provided on an "as is" basis and the author will not be
  20. liable for any damages caused or alleged to be caused directly or indirectly
  21. by using or not using this program.  Use at your own risk.
  22.  
  23.  
  24. Introduction
  25. ============
  26. For all those OS2.x-users:
  27. Starting with OS3.0 the AmigaGuide-Format has been enhanced.
  28. Besides other new features the keyword @WORDWRAP was introduced
  29. allowing the texts to adapt to the user's window-width.
  30.  
  31. AmigaGuide-Texts using this keyword can't be opened with AmigaGuide-
  32. Viewers from OS2.x.
  33.  
  34. AGuideConv removes this keyword and reformats the text to a fixed
  35. text-width. This way OS2.x-users should be able to read (some of)
  36. the OS3-AmigaGuide-Texts.
  37.  
  38. Annotation: 'AGuideConv' has been written to convert the AmigaGuide-Help
  39. from TurboCalc. I then decided to release it freely, perhaps you can
  40. use it for any other text, too. Please excuse some limitations that might
  41. arise from this fact, but first of all AGuideConv was designed to work
  42. correctly with TurboCalc.guide - and I'm really lazy ;^)
  43. (See Limitations below.)
  44.  
  45.  
  46. Usage
  47. =====
  48.  
  49. AGuideConv can be started either from workbench or from shell.
  50.  
  51. WorkBench-Usage
  52. ---------------
  53. Select the AmigaGuide-Text-Icon(s) then shift-double-click on the
  54. AGuideConv-Icon. (i.e. press down the shift-key and double-click on the
  55. icon).
  56.  
  57. For every text a requester with the filename appears. This is
  58. your last chance to abort the conversion. If you select 'OK'
  59. the text will be modified. (If you own OS1.2/1.3 no messages will
  60. be shown but the conversion with start immediately.)
  61.  
  62.  
  63. CLI-Usage
  64. ---------
  65. AGuideConv textname
  66.  
  67. Start AGuideConv with the parameter 'textname' being the AmigaGuide-Text.
  68.  
  69. Example:
  70. AGuideConv dh0:TurboCalc/TurboCalc.guide
  71.  
  72.  
  73. Attention:
  74. ----------
  75. AGuideConv replaces the texts by their converted versions, i.e. the
  76. old version will be lost!!!
  77. If AGuideConv fails, the texts will be lost. Thus it is recommended to
  78. duplicate the text before starting AGuideConv, i.e.: never ever convert
  79. a unique original version!
  80.  
  81.  
  82. What is done:
  83. -------------
  84. * @WORDWRAP, @INDEX and @FONT commands are removed
  85. * text will be wordwrapped to a fixed width of 77
  86. * style-commands (@{b}, @{ub}, @{i}, @{ui}, @{u} and @{uu}) are removed,
  87.   this is not absolutly necessary, but it should look better afterwards.
  88.  
  89.  
  90. Limitations: (see note above)
  91. -----------------------------
  92. * used textwidth cannot be changed
  93. * Reads the complete text to memory before converting
  94. * Saves the converted version to the same file!
  95.  
  96.  
  97.  
  98. The Auther
  99. ==========
  100.  
  101. This program was written by
  102.  
  103. Michael Friedrich
  104. Mühlenstr.25
  105. 77694 Kehl
  106. Germany
  107.  
  108.  
  109. EMail:
  110. ------
  111. s_friedr@ira.uka.de
  112. ukrc@rz.uni-karlsruhe.de
  113.  
  114.  
  115. If you have any problems, suggestions or bug reports (oh no :)
  116. feel free to send an EMail.
  117.  
  118.